Introduction

Overview

The Data Platform is an integrated solution that combines device management, secure data communication, message subscription, and data service capabilities. It supports connecting massive numbers of devices downstream to collect and upload device data to the cloud, while providing cloud APIs upstream that allow servers to send commands to devices for remote control. This document guides you on how to operate the Neuron Data Platform to access and manage various devices and data. After successful access, you can perform in-depth analysis of real-time and historical data and create intuitive visual reports to improve management efficiency.

Product Features

1. Device Access: The device access process is one of the core components of the Neuron Data Platform, providing users with a clear, standardized path to sequentially complete pre-configuration, communication method selection, device registration, and tag management, achieving smooth device integration.

2. Device Management: The Device Management module is one of the core functional modules of the data platform, serving as a one-stop management hub for devices. Users can perform full lifecycle operations here, from search and information maintenance to alarm configuration.

3. Device Control: The Device Control module supports users in operating connected devices remotely via commands. Through thing model control point configuration, device source definition, and personalized command settings, it enables precise remote device control functionality.

4. OpenAPI Guide: By utilizing the convenient tool of OpenAPI, developers can connect external systems with the data platform, establishing secure, automated processes for device data collection, query, and analysis.

Access Method & Prerequisites

How to access

The Data Platform provides the following two access methods:​

1. Web Portal Access: Access the official URL via a browser and log in directly with your account.
2. API Programmatic Access: Integrate and develop by calling the platform's RESTful APIs. This method requires you to first apply for a valid API token within the data platform or from an administrator.

After successful login, select the project you want to operate on. Project data resources are isolated from each other.

On the project details page, click Data Platform in the application list/right sidebar to enter the application.

Enter the Data Platform home page.

Before You Start

Permission Configuration

To ensure normal access, your account needs to be invited to the project and have permission to view the Data Platform application. If not, please contact the project administrator, or refer to 【Invite Members to Project】/【Install and Configure Permissions】.

Prerequisite Configuration

Device Preparation:

• Traditional Devices (non-IoT): Must be online and support standard industrial protocols (BACnet, Modbus, etc. – specific protocol types need confirmation with the device manufacturer);

• IoT Devices: Need to complete pre-configuration according to the access method: Device Access:

• LoRaWAN NS Access: Devices must support the LoRaWAN protocol, be registered on platforms like ChirpStack/Netmore, and have obtained DevEUI, AppId;

• MQTT Access: Devices must complete network access (Wi-Fi, Ethernet), support the MQTT protocol, and have their unique identifier recorded (IMEI/Device SN);

• API Access: Devices must support HTTP/HTTPS protocols, possess data reporting interfaces, and obtain device authentication tokens (Token);

• Bluetooth Access: Devices must support Bluetooth 4.0+ (BLE), be within the coverage range of the data platform's Bluetooth gateway, and have their Bluetooth MAC address recorded;

Document Preparation:

• Non-IoT Devices: Collect Device ID, IP Address, Port Number, Device Address, Industrial Protocol Parameters, and Data Dictionary (e.g., "HVAC-1-Temp" represents the temperature point of HVAC unit 1);

• IoT Devices:

  • LoRaWAN NS: Collect ChirpStack/Netmore platform address, Tenant ID, Application ID, DevEUI, AppID;

  • MQTT: Collect MQTT Broker address, port, subscription Topic, authentication information (Username / Password / Certificate);

  • API: Collect device reporting URL, request method (POST/GET), authentication token, data format (JSON/XML);

  • Bluetooth: Collect device Bluetooth MAC address, broadcast interval, data parsing protocol (e.g., Bluetooth SIG specification), Bluetooth Gateway ID.

Refer to the "Traditional Device Connection Guide" and "IoT Device Four Access Methods Configuration Manual" for device pre-configuration – Please note that specific configuration steps may vary depending on the access method and device manufacturer.

Terminology Explanation

Non-IoT Device: Traditional building management devices, primarily using wired connections, supporting industrial protocols (BACnet, Modbus), lacking network interaction capabilities (e.g., traditional HVAC, wired lighting controllers);

IoT Device: Smart building devices with networking/short-range communication capabilities, supporting access methods like LoRaWAN, MQTT, API, Bluetooth, capable of uploading data in real-time (e.g., smart sensors, wireless thermostats);

Device Control: The platform sends control commands to connected devices, enabling remote operation functionality.

LoRaWAN NS (Network Server): The core component of the LoRaWAN network, responsible for managing LoRaWAN devices and forwarding device data. Mainstream platforms include ChirpStack (open source), Netmore (commercial), etc.;

MQTT: A lightweight IoT communication protocol based on the publish-subscribe model, suitable for IoT device data transmission in low-bandwidth, high-latency scenarios;

API Access: Devices directly report data to the data platform via HTTP/HTTPS interfaces, suitable for devices with autonomous communication capabilities;

Bluetooth Access: IoT devices communicate with mobile APPs via BLE (Bluetooth Low Energy), and data is accessed into the data platform through the APP, suitable for short-range, low-power scenarios (e.g., indoor sensors);

Data Source: The source of building data, including non-IoT devices, IoT devices (four access methods), and third-party systems (energy management systems, property management systems);

Data Processing Rules: Rules for cleaning, transforming, and aggregating raw data (non-IoT/IoT device data) (e.g., filtering abnormal temperature values, calculating daily average energy consumption);

Data Service API: Standardized interfaces for external systems (e.g., operational dashboards, mobile APPs) to call data from the data platform, supporting query and subscription modes;

Data Dashboard: A visual interface displaying key building metrics (e.g., device operating status, energy consumption trends) in chart form (line charts, bar charts, gauges);

Time-Series Database (TSDB): The underlying storage engine of the data platform, specifically designed for storing high-frequency time-series data from both non-IoT and IoT devices (e.g., temperature data at 1-minute intervals).

Time-Series Data: A series of data points with timestamps, used to describe the state or measured value of a device at a specific point in time. It is the most common data type in the Internet of Things field;

Data Warehouse Data: Business data or master data stored in a data warehouse, usually cleaned and aggregated, suitable for more complex analysis and reporting;

Topic: In the MQTT protocol, a Topic is a UTF-8 string used for addressing and filtering messages. It acts as a virtual message channel between message publishers and subscribers, serving as the core mechanism for message routing.

Detailed Explanation of Topic Category Differences:

Feature	Exact Match	Wildcard Match
Definition	A complete, specific topic name that must exactly match the published message's topic	A topic filter containing special characters, used to match a category of topics
Usage Scenario	Primarily used for publishing messages. Can also be used for subscribing, but only to one specific topic	Used only for subscribing, cannot be used for publishing messages
Characters Allowed	Only allows the topic level separator / and normal UTF-8 characters; cannot contain + or #	Besides normal characters and /, also includes the single-level wildcard + and the multi-level wildcard #
Matching Rule	Exact equality level by level	+ matches one complete level; # matches any number (including zero) of levels and must be the last character in the filter
Example Topic	application/app_001/device/dev_123/event/up	application/+/device/+/event/up

ETL Converter: The core component of the data platform that converts the diverse, non-standard data formats reported by devices into standardized data formats that the platform can uniformly recognize and process.

RSA Token: An API authentication credential based on asymmetric encryption algorithms, using a public key encryption, private key decryption mechanism to ensure data transmission security.

JWT Token: A JSON-based open standard token that uses digital signatures to ensure token integrity and trustworthiness.